Api.ReadAxisActualVelocity method

Reads the actual velocity from an axis.

Namespace: IntervalZero.KINGSTAR.OpcUa.Api

Assembly: IntervalZero.KINGSTAR.OpcUa.Api (in IntervalZero.KINGSTAR.OpcUa.Client.dll) Version: 4.4.0.0

Syntax

C#VB
public KsReturn<int> ReadAxisActualVelocity(
       int Index
)
Public Function ReadAxisActualVelocity(
       Index As Integer
) As KsReturn(Of Integer)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Type: KsReturn<Int>

Returns a KsError code and an integer value.

Remarks

Used in the cyclic callback to check the actual velocity of an axis.

NOTE:  Actual velocity is available only if EnableActualVelocity is enabled.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

Api Class

IntervalZero.KINGSTAR.OpcUa.Api Namespace